Deactivate User

Deactivates the specified User

PUT{accelqLoginUrl}/awb/api/2.0/{tenantCode}/administration/users/deactivate/{userPid}

Headers

Header	Value
`user_id`	Login username (email)
`api_key`	API key of the user for authentication
`Content-Type`	application/json
`Accept`	application/json

Parameters

Parameter	Type	Required	Description
`accelqLoginUrl`	string	Yes	The AccelQ login URL for API access.
`tenantCode`	string	Yes	Tenant code for identifying the organization.
`userPid`	integer	Yes	Unique identifier of the user
`user_id`	string	Yes	Login username (email)
`api_key`	string	Yes	API key of the user for authentication

Responses

200 - User deactivation successful

json

true

400 - Bad Request Error

json

{
  "error": "Active To date must be after Active From date"
}

403 - Forbidden - User does not have permission to activate users

json

{
  "error": "User does not have authorization to access this feature"
}

404 - User not found

json

{
  "error": "User with pid : '26' doesnot exist."
}

cURL Command Builder

URL Parameters

accelqLoginUrl (string) *

tenantCode (string) *

userPid (integer) *

Headers

user_id (string) *

api_key (string) *

Request Sample (cURL)

curl -X PUT "${{accelqLoginUrl}}/awb/api/2.0/${{tenantCode}}/administration/users/deactivate/${{userPid}}" \
  -H "user_id: ${{user_id}}" \
  -H "api_key: ${{api_key}}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"